Package | hl7.fhir.us.ecr |
Type | StructureDefinition |
Id | Id |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/ecr/https://build.fhir.org/ig/HL7/case-reporting/StructureDefinition-ersd-plandefinition.html |
Url | http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition |
Version | 2.1.2 |
Status | active |
Date | 2024-10-30T18:38:04+00:00 |
Name | ERSDPlanDefinition |
Title | eRSD PlanDefinition |
Experimental | False |
Realm | us |
Authority | hl7 |
Description | This PlanDefinition profile defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician. The rules for determining reportability described by an eRSD specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events. The final determination of reportability is made by the Public Health Agency or Agencies appropriate for the event, and may be performed by a combination of decisions occurring at various points during the processing of an eICR, as explained in the Reportability Response profile. |
Type | PlanDefinition |
Kind | resource |
CapabilityStatement | |
capabilitystatement-ersd-client | Capability Statement eRSD Client |
StructureDefinition | |
us-ph-fhirquerypattern-extension | US Public Health FHIR Query Pattern Extension |
us-ph-named-eventtype-extension | US Public Health Named Event Type Extension |
us-ph-plandefinition | US Public Health PlanDefinition |
http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action | US Public Health PlanDefinition Action |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ersd-plandefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | S | 1..1 | USPublicHealthPlanDefinition | eRSD - electronic Reporting and Surveillance Distribution |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
variable | S | 0..* | Expression | Variable for processing URL: http://hl7.org/fhir/StructureDefinition/variable |
Slices for action | S | 5..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id |
action:All Slices | Content/Rules for all slices | |||
code | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition |
input | 0..* | DataRequirement | Input data requirements | |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
us-ph-fhirquerypattern-extension | S | 0..1 | (Complex) | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension |
url | S | 1..1 | uri | "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension" |
relatedAction | ||||
offsetDuration | S | 0..1 | Duration | Time offset for the relationship |
action:encounterStart | S | 1..1 | BackboneElement | Encounter start code |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow |
description | S | 1..1 | string | Description of the "start" action. Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event. |
textEquivalent | S | 1..1 | string | Text equivalent of the "start" action. Fixed Value: Start the reporting workflow in response to an encounter-start event |
code | S | 1..1 | CodeableConcept | Code for the "start" action. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |
trigger | SC | 1..* | TriggerDefinition | When the "start" action should be triggered. epd-1: The code value of the namedEventType SHALL be the same as the name element |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents |
type | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event | |
name | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-start | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: check-suspected-disorder | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
offsetDuration | 0..1 | Duration | Time offset for the relationship Example Wait 1 hour before next action.: {"value":1,"unit":"h"} | |
action:checkSuspectedDisorder | S | 1..1 | BackboneElement | Check suspected disorder |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-suspected-disorder |
description | S | 1..1 | string | Description of the check for suspected disorders action. Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event. |
code | S | 1..1 | CodeableConcept | Code for the "check-suspected-disorder" action. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 2..* | A sub-action Slice: Unordered, Open by value:id | ||
action:isEncounterSuspectedDisorder | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-suspected-disorder |
code | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: create-eicr | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:continueCheckReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: continue-check-reportable |
code | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: check-reportable | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
offsetDuration | 0..1 | Duration | Time offset for the relationship Example Wait 6 hours before next action.: {"value":6,"unit":"h"} | |
action:checkReportable | 1..1 | BackboneElement | Check the encounter for reportability | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportable |
description | 0..1 | string | Description of the Periodic Update of eICR action. Fixed Value: This action represents the check for suspected reportability of the eICR. | |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 3..* | A sub-action Slice: Unordered, Open by value:id | ||
action:isEncounterReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-reportable |
code | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: check-trigger-codes | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: create-eicr | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:checkUpdateEicr | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-update-eicr |
code | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: create-eicr | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:encounterInProgress | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-encounter-in-progress |
code | 1..* | CodeableConcept | Code representing the meaning of the action or sub-actions Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri |